/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * <http://www.mongodb.com/licensing/server-side-public-license>.
 */
package org.graylog.security.shares;

import org.graylog.grn.GRN;

import java.util.Set;
import java.util.function.Predicate;
import java.util.stream.Stream;

public interface PluggableEntityHandler {
    /**
     * Pluggable handler for actions related to specific entity types.
     */
    void onCreate(GRN entity, Set<GRN> collections);

    /**
     * Returns a predicate that tests whether a given GRN should be excluded from handling by this Entity Handler.
     *
     * @return a predicate that returns {@code true} if the GRN should not be handled,
     * or {@code false} if it can be handled
     */
    Predicate<GRN> entityFilter();

    Stream<GRN> expand(GRN grn);
}
